home *** CD-ROM | disk | FTP | other *** search
/ Tech Arsenal 1 / Tech Arsenal (Arsenal Computer).ISO / tek-01 / key_c31.zip / README.DOC < prev    next >
Text File  |  1992-05-11  |  7KB  |  149 lines
  1. KEYTREE UTILITIES VERSION 3.1 - MAY 1992 (Copyright Rewse Consultants Ltd)
  2. __________________________________________________________________________
  3.  
  4.           ┌─────────┐
  5.     ┌─────┴───┐     │              (R)
  6.       ──│         │o    │──────────────────
  7.     │   ┌─────┴╨──┐ │  Association of
  8.     │   │         │─┘  Shareware
  9.     └───│    o    │    Professionals
  10.       ──────│    ║    │────────────────────
  11.         └────╨────┘    MEMBER
  12.  
  13. _____________________________________________________________________________
  14.  
  15. The KeyTree Utilities is a set of library routines for C programmers for the
  16. creation, access and maintenance of indexed files of variable length records.
  17.  
  18. The files that should be on this disk are :
  19.  
  20.     README.DOC   - this file
  21.     KEYTREE3.C   - the source code of the KeyTree Utilities
  22.     KTERROR.C    - plain language version of KeyTree exception codes
  23.     KTREE3.H     - definitions of the KeyTree commands
  24.     TUTOR.EXE    - a tutorial program which allows you to create simple
  25.            files and access them using the utilities
  26.     NAMES.FIL    - a simple file which can be used by TUTOR.EXE
  27.     MANUAL.EXE   - an electronic manual describing the KeyTree Utilities
  28.     MANUAL.FIL   - which is used by MANUAL.EXE
  29.     SAMPLES.EXE  - an electronic manual showing some useful examples
  30.     SAMPLES.FIL  - which is used by SAMPLES.EXE
  31.     LOOK.EXE     - a program for looking at KeyTree files in detail
  32.            (very good for understanding how the KeyTree system works)
  33.     CLEANUP.EXE  - a program for cleaning up KeyTree files (getting rid of
  34.            dead records)
  35.     ADDINDEX.EXE - a program for adding additional indexes to an existing
  36.            KeyTree file. It is unlikely that you will ever want to
  37.            add new keys permanently to a file. However suppose you
  38.            had a customer file keyed by customer number, and you
  39.            also had a one-off need to access these in post code
  40.            sequence. You could use this program to change the key
  41.            to post code plus customer number, and use the temporary
  42.            file created (TMP1.$$$) for the processing.
  43.     CONV2TO3.EXE - a program for converting files created under version 2
  44.            of the KeyTree Utilities to the version 3 format. If you
  45.            never had version 2, then you certainly don't need this!
  46.     SCANPLUS.EXE - a program for finding keyboard scan codes - totally
  47.            unrelated to the KeyTree Utilities, but we hope you find
  48.            it useful!
  49.     ORDER.DOC    - print this file and send it to us when you register your
  50.            use of the KeyTree Utilities
  51.     SHR-WARE.DOC - a description of shareware and the Association of
  52.            Shareware Professionals
  53.  
  54.  
  55. COMPILING THE KEYTREE UTILITIES
  56. _______________________________
  57.  
  58.     1. If your compiler does not support multiple source files, then the
  59.        first line of your program should be
  60.  
  61.        #include "keytree3.c"
  62.  
  63.     2. Since most compilers do support multiple source files, it is more
  64.        sensible to compile KEYTREE3.C as a separate object file. In this
  65.        case, the first line of any source file that uses the KeyTree
  66.        Utilities should be
  67.  
  68.        #include "ktree3.h"
  69.  
  70.  
  71. WARRANTY & SUPPORT
  72. __________________
  73.  
  74.     Whilst we have taken every care to ensure that the KeyTree Utilities work
  75.     as specified, there is an ancient programmers saying - "Every program
  76.     contains at least one bug!". We don't propose to enter into a deep
  77.     philosophical discussion on the truth or otherwise of this saying, but
  78.     it is a brave man indeed who offers any warranty on the accuracy of
  79.     software. Therefore, in common with every other software supplier we
  80.     have ever come across, we offer no particular warranty regarding the
  81.     use of the KeyTree Utilities, and it is your responsibility to ensure
  82.     that your programs, which use the KeyTree Utilities, work.
  83.  
  84.     However, in the unlikely event that you find some combination which does
  85.     not do what you expected, we want to hear from you. Please write to us
  86.     at the address below, and we will endeavour to explain the problem.
  87.  
  88.     The KeyTree Utilities has been tested using the following compilers :
  89.  
  90.     Borland Turbo C++ version 1.01
  91.     Zortech C++       version 2.1
  92.     Microsoft QuickC  version 2.0
  93.     Watcom Express C  version 7.0
  94.     Mix Power C       version 1.2.0
  95.  
  96.     Since this is a fairly representative selection of compilers, the
  97.     KeyTree Utilities should be acceptable to any compiler which claims
  98.     ANSI compatibility. This does not include Mix C Works, which does
  99.     not support the int86 function amongst other anomalies. If your
  100.     compiler throws up any warning messages (or, heaven forfend, error
  101.     messages) please let us know.
  102.  
  103.  
  104. COPYRIGHT & (ABSENCE OF) ROYALTIES
  105. __________________________________
  106.  
  107.     The copyright in KeyTree Utilities (which includes all the files listed
  108.     above) is the property of Rewse Consultants Limited. You may make as
  109.     many copies of the KeyTree Utilities as you wish, BUT -
  110.  
  111.     i)  you may not SELL the KeyTree Utilities to any third party and
  112.  
  113.     ii) if you GIVE the KeyTree Utilities to any third party, you MUST
  114.     give them all of the files listed above, particularly this one,
  115.     and the same conditions apply to the third party.
  116.  
  117.     In other words, we are impoverished programmers trying to earn an
  118.     honest crust, and you wouldn't want to deprive our children of a new
  119.     pair of shoes, would you?
  120.  
  121.     No royalty is expected for programs which you create using the KeyTree
  122.     Utilities and then distribute to third parties as executable files.
  123.     However, we would be interested to hear about your use of the software.
  124.  
  125.     The KeyTree Utilities are issued as shareware. In case you are unaware of
  126.     how the shareware system works, it is NOT 'free' software. No initial
  127.     charge is made for the software, so that you can try it out without
  128.     obligation. However, if you continue to use the software (and in the case
  129.     of the KeyTree Utilities, use programs created using them), then you are
  130.     required to pay a registration fee. If you don't think the KeyTree
  131.     Utilities are worth the registration fee..... well, thanks for your
  132.     interest. Just stop using them, and you don't owe us a thing. A more
  133.     detailed description of shareware can be found in the file SHR-WARE.DOC.
  134.  
  135.     To register your use of the software, we ask you to pay a miserly
  136.     £30 (UK Pounds), a mere fraction of the amount that you are saving
  137.     in time and effort.
  138.  
  139.     Please send your registration fee to :
  140.  
  141.        Rewse Consultants Limited
  142.        44, Horseshoe Road, Pangbourne, Reading, Berkshire RG8 7JL,
  143.        United Kingdom
  144.  
  145.  
  146.     You can pay the registration fee by Visa or Mastercard - just send us the
  147.     account number and date of expiry, and sign the letter authorising us to
  148.     charge it to your account.
  149.